Revise some API docs due to aggressive combining #35
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
By aggressively combining IR elements, the combiner could create peripherals that have incorrect documentation. This multi-faceted PR addresses some invalid documentation in the RAL.
First, we remove specific cases of reserved registers. Users shouldn't touch them anyway, and it's nice to remove code. It also forces the combiner to treat fieldsets for CCM clock gates differently. This corrects most of the documentation issues presented in #32, but not all.
To fix all of the clock gate documentation, we build on #34 and introduce a new combiner configuration. A "never combine" configuration should prevent any kind of IR element from combining. It's tested with the CCM clock gate fieldsets.
But there's still documentation inconsistencies in IOMUXC, and I couldn't find a way to express the corrections in terms of "never combine" configurations. So there's another combiner configuration that requires the documentation of an enum variant to match across chips. This fixes IOMUXC documentation.